Skip to content

[AppKit] Document ten enum types - #26571

Merged
rolfbjarne merged 11 commits into
mainfrom
dev/rolf/xmldocs-057-batch
Sep 7, 2026
Merged

[AppKit] Document ten enum types#26571
rolfbjarne merged 11 commits into
mainfrom
dev/rolf/xmldocs-057-batch

Conversation

@rolfbjarne

@rolfbjarne rolfbjarne commented Sep 7, 2026

Copy link
Copy Markdown
Member

Document ten AppKit enum types and all their members:

  • NSCollectionViewDropOperation
  • NSUserInterfaceLayoutOrientation
  • NSSliderType
  • NSPopoverAppearance
  • NSTableViewRowActionStyle
  • NSWindowTitleVisibility
  • NSVisualEffectBlendingMode
  • NSStatusItemBehavior
  • NSTouchType
  • NSTouchTypeMask

Remove the matching entries from the Cecil documentation known-failures list.

🤖 Pull request created by Copilot

rolfbjarne and others added 11 commits September 7, 2026 13:48
@rolfbjarne
[AppKit] Document NSCollectionViewDropOperation
633a99d 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSUserInterfaceLayoutOrientation
e7d3e72 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSSliderType
2541f7f 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSPopoverAppearance
7188dfe 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSTableViewRowActionStyle
a2d80e2 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSWindowTitleVisibility
f9f86fa 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSVisualEffectBlendingMode
ed24386 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSStatusItemBehavior
bbf3b1d 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSTouchType
58ba8d8 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Document NSTouchTypeMask
cb164e9 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[AppKit] Clarify status item termination behavior
b4a7168 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Copilot AI lite review requested due to automatic review settings September 7, 2026 11:54
Copilot AI reviewed Sep 7, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The changes are documentation-only and the known-failures list updates match the newly documented enum types.

Pull request overview

This PR improves the AppKit binding documentation by adding XML documentation for ten existing enum types (and their members) in src/AppKit/Enums.cs, and then removing those enums from the Cecil documentation known-failures list so the documentation tests can enforce the new coverage.

Changes:

  • Added XML <summary> documentation for 10 AppKit enums and their members in src/AppKit/Enums.cs.
  • Removed the corresponding enum entries from tests/cecil-tests/Documentation.KnownFailures.txt to reflect the improved documentation coverage.
File summaries
File Description
src/AppKit/Enums.cs Adds enum/member XML documentation for the specified AppKit enum types.
tests/cecil-tests/Documentation.KnownFailures.txt Drops known-failure entries for those enums so Cecil doc validation expects them to be documented.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread src/AppKit/Enums.cs
@rolfbjarne
rolfbjarne enabled auto-merge (squash) September 7, 2026 12:00
@vs-mobiletools-engineering-service2

vs-mobiletools-engineering-service2 commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

✅ API diff for current PR / commit

NET (empty diffs)

✅ API diff vs stable

NET (empty diffs)

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: b4a71684d417d4c0f854054ea7f47c91301141de [PR build]

@vs-mobiletools-engineering-service2

vs-mobiletools-engineering-service2 commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator

🚀 [CI Build #b4a7168] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 264 tests passed 🎉

Tests counts

✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 7 tests passed. Html Report (VSDrops) Download
✅ linker (iOS): All 31 tests passed. Html Report (VSDrops) Download
✅ linker (MacCatalyst): All 31 tests passed. Html Report (VSDrops) Download
✅ linker (macOS): All 21 tests passed. Html Report (VSDrops) Download
✅ linker (tvOS): All 31 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 25 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 25 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 20 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 25 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ sharpie: All 1 tests passed. Html Report (VSDrops) Download
✅ windows: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

macOS tests

✅ Tests on macOS Sonoma (14): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Sequoia (15): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Tahoe (26): All 5 tests passed. Html Report (VSDrops) Download

Linux Build Verification

✅ Linux build succeeded

Pipeline on Agent
Hash: b4a71684d417d4c0f854054ea7f47c91301141de [PR build]

@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Sep 7, 2026
@rolfbjarne
rolfbjarne merged commit cb89cde into main Sep 7, 2026
55 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-057-batch branch September 7, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@dalexsoto dalexsoto dalexsoto approved these changes

Assignees

No one assigned

Labels

copilot ready-to-review This PR is ready to review/merge.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rolfbjarne @vs-mobiletools-engineering-service2 @dalexsoto